Skip to content

Update Enhancement #13142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Enhancement #13142

wants to merge 1 commit into from

Conversation

Sathi-Seth
Copy link

@Sathi-Seth Sathi-Seth commented Oct 3, 2025 •
edited
Loading

Describe your change:

1. Add Contenets
2. Installation Process added
3. Usage
4. Features(Link redirect to TheAlgorithm website's tutorial link)
5. license Add

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

After doing some enhancement
Screenshot 2025-10-03 210510

@algorithms-keeper algorithms-keeper bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Oct 3, 2025
@Sathi-Seth Sathi-Seth changed the title Update for Enhancement Update Enhancement Oct 3, 2025
rohitmane01
rohitmane01 reviewed Oct 4, 2025
View reviewed changes
Copy link

@rohitmane01 rohitmane01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not rely solely on ChatGPT or other code generators. Make sure to verify the code and documentation you are submitting before raising a PR. This will help maintainers and fellow contributors ensure code quality and maintain project standards.

README.md

## 🧑‍💻 Installation
```bash
git clone https://github.com/username/Python
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this git clone Command properly.
It should be git clone https://github.com/TheAlgorithms/Python.git

README.md
## 📖 Usage
python alogorithm_name.py

## 🌟Features
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should act like a table of contents.
it means it should mention the list of main types of algorithms in the repo.

README.md
Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion.

## 🚀 Getting Started

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the old code and the short links attached section as it is.
Refer to the image for more clarity.
image

@Sathi-Seth Sathi-Seth requested a review from rohitmane01 October 4, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rohitmane01 rohitmane01 Awaiting requested review from rohitmane01

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Sathi-Seth @rohitmane01